Documentation
checkouts

Update Checkout Session from Client

patch
/v1/checkouts/custom/client/{client_secret}
Update a checkout session by client secret.
curl -X PATCH \
    'https://api.polar.sh/v1/checkouts/custom/client/string' \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{}'
Responses
{
  "created_at": "2024-10-16T00:00:00.000Z",
  "modified_at": "2024-10-16T00:00:00.000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "payment_processor": "stripe",
  "status": "open",
  "client_secret": "string",
  "expires_at": "2024-10-16T00:00:00.000Z",
  "success_url": "string",
  "amount": 0,
  "tax_amount": 0,
  "currency": "string",
  "total_amount": 0,
  "product_id": "00000000-0000-0000-0000-000000000000",
  "product_price_id": "00000000-0000-0000-0000-000000000000",
  "is_payment_required": false,
  "customer_id": "00000000-0000-0000-0000-000000000000",
  "customer_name": "string",
  "customer_email": "string",
  "customer_ip_address": "string",
  "customer_billing_address": {
    "line1": "string",
    "line2": "string",
    "postal_code": "string",
    "city": "string",
    "state": "string",
    "country": "string"
  },
  "customer_tax_id": "string",
  "payment_processor_metadata": {},
  "product": {
    "created_at": "2024-10-16T00:00:00.000Z",
    "modified_at": "2024-10-16T00:00:00.000Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string",
    "is_recurring": false,
    "is_archived": false,
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "prices": [
      {
        "created_at": "2024-10-16T00:00:00.000Z",
        "modified_at": "2024-10-16T00:00:00.000Z",
        "id": "00000000-0000-0000-0000-000000000000",
        "amount_type": "fixed",
        "is_archived": false,
        "price_currency": "string",
        "price_amount": 0,
        "type": "recurring",
        "recurring_interval": "month"
      }
    ],
    "benefits": [
      {
        "created_at": "2024-10-16T00:00:00.000Z",
        "modified_at": "2024-10-16T00:00:00.000Z",
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "custom",
        "description": "string",
        "selectable": false,
        "deletable": false,
        "organization_id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "medias": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "organization_id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "path": "string",
        "mime_type": "string",
        "size": 0,
        "storage_version": "string",
        "checksum_etag": "string",
        "checksum_sha256_base64": "string",
        "checksum_sha256_hex": "string",
        "last_modified_at": "2024-10-16T00:00:00.000Z",
        "version": "string",
        "service": "product_media",
        "is_uploaded": false,
        "created_at": "2024-10-16T00:00:00.000Z",
        "size_readable": "string",
        "public_url": "string"
      }
    ]
  },
  "product_price": {
    "created_at": "2024-10-16T00:00:00.000Z",
    "modified_at": "2024-10-16T00:00:00.000Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "amount_type": "fixed",
    "is_archived": false,
    "price_currency": "string",
    "price_amount": 0,
    "type": "recurring",
    "recurring_interval": "month"
  },
  "url": "string"
}